/*
 * (C) Copyright 2006-2010 Nuxeo SAS (http://nuxeo.com/) and contributors.
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the GNU Lesser General Public License
 * (LGPL) version 2.1 which accompanies this distribution, and is available at
 * http://www.gnu.org/licenses/lgpl.html
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * Contributors:
 *     bstefanescu
 */
package org.nuxeo.gwt.habyt.invocation.client;

import java.io.Serializable;

/**
 * An object than can be referenced on the server side. This interface is used
 * instead of {@link ObjectRef} to ensure that references sent to server side
 * inside invocations are light objects. This way you can not sent a
 * {@link DataModel} instance (which may be a large object) to the server to
 * reference an object - because the invocation will grab the real reference
 * from the data model by using the Referenceable contract.
 * 
 * This indirection gives more flexibility in public API (i.e. you can use any
 * referenceable object as a target in invocations without sending on the server
 * the whole data of the real object).
 * 
 * @author <a href="mailto:bs@nuxeo.com">Bogdan Stefanescu</a>
 * 
 */
public interface Referenceable extends Serializable {

    public ObjectRef getRef();

}
